Add contracttrait macro internal developer documentation#1655
Merged
leighmcculloch merged 7 commits intomainfrom Dec 19, 2025
Merged
Add contracttrait macro internal developer documentation#1655leighmcculloch merged 7 commits intomainfrom
leighmcculloch merged 7 commits intomainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive internal developer documentation for the #[contracttrait] macro system, explaining the complex multi-stage expansion process used to handle default trait function implementations in Soroban smart contracts.
Key Changes
- Documents the multi-stage macro expansion process from trait definition through final code generation
- Explains the
macro_rules!bridge pattern used to carry trait metadata from definition to implementation time - Includes a visual diagram and detailed stage-by-stage breakdown of the macro expansion pipeline
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
17 tasks
dmkozh
approved these changes
Dec 19, 2025
Member
Author
|
I removed the excalidraw diagram and replaced it with a mermaidjs diagram that is defined inline in the doc. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Add internal documentation explaining how the
#[contracttrait]macro works, including the multi-stage expansion process for handling default trait functions, the macro_rules bridge pattern, and a diagram of the system.Why
SDK developers need to understand the macro internals to modify or debug the implementation, particularly the complex interaction between
#[contracttrait],#[contractimpl], and the generated declarative macro bridge.